<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>NPanday - xsd:xsd</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            NPanday :: XSD Maven Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2010-01-21
                      </div>
            <div class="xright">            <a href="http://incubator.apache.org/projects/npanday.html" class="externalLink">Project Site</a>
            |
                <a href="http://incubator.apache.org/npanday" class="externalLink">NPanday</a>
            |
                <a href="http://svn.apache.org/repos/asf/incubator/npanday/" class="externalLink">NPanday SVN</a>
            |
                <a href="http://maven.apache.org/" class="externalLink">Maven</a>
            |
                <a href="http://www.mono-project.com/" class="externalLink">Mono Project</a>
            |
                <a href="http://dotgnu.org/" class="externalLink">DotGNU</a>
            
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>General Info</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">About</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
              
    <li class="none">
                    <a href="usage.html">Usage</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
            
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="xsd:xsd"></a>xsd:xsd</h2>
<p><strong>Full name</strong>:</p>
<p>npanday.plugin:maven-xsd-plugin:1.1:xsd</p>
<p><strong>Description</strong>:</p>
<div>Generates XSD class.</div><p><strong>Attributes</strong>:</p>
<ul><li>Requires a Maven 2.0 project to be executed.</li>
<li>Binds by default to the lifecycle phase: <code>process-sources</code>.</li>
</ul>
<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#outputDirectory">outputDirectory</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The directory to place the generated binding classes.<br />
<strong>Default value is</strong>: <code>${project.build.directory}${file.separator}build-sources</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#project">project</a></strong></td>
<td><code>MavenProject</code></td>
<td><code>-</code></td>
<td>The maven project.<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#xsdFile">xsdFile</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#elements">elements</a></strong></td>
<td><code>ArrayList</code></td>
<td><code>-</code></td>
<td>Specifies the element(s) in the schema to generate code for. Not
supported for MONO.<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#enableDataBinding">enableDataBinding</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Generates the INotifyPropertyChanged interface to enable data
binding. Not supported for MONO.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#fields">fields</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Generates fields instead of properties. Not supported for MONO.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#frameworkVersion">frameworkVersion</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>(no description)<br />
<strong>Default value is</strong>: <code>2.0.50727</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#generate">generate</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Generate either classes or dataset.<br />
<strong>Default value is</strong>: <code>classes</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#ignoreUnusedOptions">ignoreUnusedOptions</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Tells the xsd plugin to ignore options not appropriate to the xsd
vendor.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#language">language</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Programming language to use.<br />
<strong>Default value is</strong>: <code>CS</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#namespace">namespace</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Runtime namespace for the generated types.<br />
<strong>Default value is</strong>: <code>${project.artifactId}</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#netHome">netHome</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>The home directory of your .NET SDK.<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#order">order</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Generates explicit order identifiers on all particle members. Not
supported for MONO.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#profile">profile</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The profile that the executable should use.<br />
<strong>Default value is</strong>: <code>XSD:SCHEMA</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#vendor">vendor</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>The Vendor for the executable. Supports MONO and MICROSOFT.<br />
</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><strong><a name="elements">elements</a>:</strong></p>
<div>Specifies the element(s) in the schema to generate code for. Not
supported for MONO.</div><ul><li><strong>Type</strong>: <code>java.util.ArrayList</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${elements}</code></li>
</ul>
<hr />
<p><strong><a name="enableDataBinding">enableDataBinding</a>:</strong></p>
<div>Generates the INotifyPropertyChanged interface to enable data
binding. Not supported for MONO.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${enableDataBinding}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="fields">fields</a>:</strong></p>
<div>Generates fields instead of properties. Not supported for MONO.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${fields}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="frameworkVersion">frameworkVersion</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${frameworkVersion}</code></li>
<li><strong>Default</strong>: <code>2.0.50727</code></li>
</ul>
<hr />
<p><strong><a name="generate">generate</a>:</strong></p>
<div>Generate either classes or dataset.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${generate}</code></li>
<li><strong>Default</strong>: <code>classes</code></li>
</ul>
<hr />
<p><strong><a name="ignoreUnusedOptions">ignoreUnusedOptions</a>:</strong></p>
<div>Tells the xsd plugin to ignore options not appropriate to the xsd
vendor.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="language">language</a>:</strong></p>
<div>Programming language to use.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${language}</code></li>
<li><strong>Default</strong>: <code>CS</code></li>
</ul>
<hr />
<p><strong><a name="namespace">namespace</a>:</strong></p>
<div>Runtime namespace for the generated types.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${namespace}</code></li>
<li><strong>Default</strong>: <code>${project.artifactId}</code></li>
</ul>
<hr />
<p><strong><a name="netHome">netHome</a>:</strong></p>
<div>The home directory of your .NET SDK.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${netHome}</code></li>
</ul>
<hr />
<p><strong><a name="order">order</a>:</strong></p>
<div>Generates explicit order identifiers on all particle members. Not
supported for MONO.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${order}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="outputDirectory">outputDirectory</a>:</strong></p>
<div>The directory to place the generated binding classes.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${outputDirectory}</code></li>
<li><strong>Default</strong>: <code>${project.build.directory}${file.separator}build-sources</code></li>
</ul>
<hr />
<p><strong><a name="profile">profile</a>:</strong></p>
<div>The profile that the executable should use.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${profile}</code></li>
<li><strong>Default</strong>: <code>XSD:SCHEMA</code></li>
</ul>
<hr />
<p><strong><a name="project">project</a>:</strong></p>
<div>The maven project.</div><ul><li><strong>Type</strong>: <code>org.apache.maven.project.MavenProject</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${project}</code></li>
</ul>
<hr />
<p><strong><a name="vendor">vendor</a>:</strong></p>
<div>The Vendor for the executable. Supports MONO and MICROSOFT.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${vendor}</code></li>
</ul>
<hr />
<p><strong><a name="xsdFile">xsdFile</a>:</strong></p>
<div>(no description)</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${xsdFile}</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2010
    
          NPanday
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
